home *** CD-ROM | disk | FTP | other *** search
/ The Arsenal Files 8 / The Arsenal Files Collection #8 (Arsenal Computer) (1996).ISO / dosutils / batkit57.zip / BATKIT.DOC < prev    next >
Text File  |  1996-09-11  |  59KB  |  1,265 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.                                       BatKit
  10.  
  11.                                   Utilities for
  12.                                    Batch Files
  13.  
  14.                                         by
  15.  
  16.                                     Ken Hipple
  17.                              [72241,65 or 74076,2331]
  18.                                All Rights Reserved
  19.  
  20.             [Including: GetKey, SaveDir, Wait, GetScrn, and MakeScrn]
  21.  
  22.  
  23.                             Copyright 1988-95, 1996 by
  24.  
  25.                                     Ken Hipple
  26.                                311 Summer Oak Trail
  27.                                 Madison, MS 39110
  28.  
  29.  
  30.      BatKit   ver. 5.7               8/13/96                          Page: 2
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.                         T A B L E   O F   C O N T E N T S
  39.  
  40.  
  41.      GETKEY...................................................3
  42.  
  43.           OVERVIEW............................................3
  44.           USING GETKEY........................................4
  45.                Usage..........................................4
  46.                Response Editing...............................4
  47.           COMMAND LINE........................................5
  48.           DISPLAYING TEXT.....................................11
  49.                # control character............................11
  50.                @ control character............................11
  51.           GETKEY 4.x AND GETSTRNG COMPATIBILITY...............17
  52.      WAIT.....................................................18
  53.  
  54.      SAVEDIR..................................................19
  55.  
  56.      GETSCRN..................................................20
  57.  
  58.      USING THE DOS ENVIRONMENT................................21
  59.  
  60.      REGISTERING BatKit.......................................23
  61.  
  62.      DISTRIBUTION NOTICE......................................24
  63.  
  64.      CHANGES SINCE RELEASE 5.0................................25
  65.  
  66.  
  67.      BatKit   ver. 5.7               8/13/96                          Page: 3
  68.  
  69.  
  70.  
  71.      GETKEY OVERVIEW:
  72.  
  73.        GetKey is a utility program designed for use in batch files.  Its main
  74.      function is to make batch files interactive by allowing the user to
  75.      enter a response to a prompt or question.  A menu system can be created
  76.      by using GetKey, some text files, and some batch files.  Other uses
  77.      include displaying text files or messages, and playing tones.
  78.  
  79.        With GetKey you can use a single batch (BAT) file and a single text
  80.      file to control the operation of a system from startup to shutdown.
  81.  
  82.        GetKey has been tested with MS-DOS versions 2.1 through 6.2.  Features
  83.      of GetKey include:
  84.  
  85.       - Returns an ERRORLEVEL for all    - Option to wait for RETURN key
  86.         keys including function keys       before accepting a response
  87.  
  88.       - Option to insert response        - Can wait a given time for a
  89.         into the environment               response and then continue
  90.  
  91.       - Fast text display & screen       - Can display a file, message or
  92.         handling                           both
  93.  
  94.       - Optional response echoing        - Can display a section of a file
  95.  
  96.       - Optional bad response message    - Flexible color handling
  97.  
  98.       - Option to delete bad responses   - Time and date display options
  99.  
  100.       - Optional beep on bad response    - Does display delays and pauses
  101.  
  102.       - Built-in help screens            - 'Smart' clear screen function
  103.  
  104.       - Clear type-ahead buffer option   - Screen mode switching
  105.  
  106.       - Background tone playing          - Optional response validation
  107.  
  108.       - Adjustable max. response length  - Can trim spaces from response
  109.  
  110.       - Option to force uppercase        - Defaults can be modified
  111.  
  112.       - Screen blanking                  - Response logging
  113.  
  114.       - Share environment variables between DOS sessions under Windows 3.x
  115.  
  116.  
  117.      BatKit   ver. 5.7               8/13/96                          Page: 4
  118.  
  119.  
  120.  
  121.      USING GETKEY:
  122.  
  123.         When executed, GetKey displays any file or message specified and then
  124.      waits for the user to enter a response.  You can specify the maximum
  125.      acceptable response length.  Responses can be validated if you desire.
  126.      The ASCII value of the first letter of the response is returned to the
  127.      batch file in ERRORLEVEL.  The response can also be placed into the
  128.      environment.  Function keys return their extended ASCII values plus 128.
  129.      These values are:
  130.  
  131.                          F1-F10    SHIFT F1-F10   CTRL F1-F10   ALT F1-F10
  132.      Value Returned:     187-196     212-221        222-231      232-241
  133.                      F11:  133         135            137          139
  134.                      F12:  134         136            138          140
  135.                     (Note: F11 and F12 will not work on some systems)
  136.  
  137.      Usage:
  138.       GetKey   ?  /A  /B  /BL[nn]["msg"]  /C  /D  /DF"rsp"  /E  /F"file[@s]"
  139.                /G["chr"]  /H  /I  /K"chrs"|/KF"file[@s]"  /Lnnn  /LG"file"
  140.                /M"msg"  /N["chr"]  /O  /P  /PI  /R  /S  /T  /U  /V["var"]
  141.                /Wnnnn  /X  /Z
  142.  
  143.      Items in [] are optional.  The character | means or (for example, you
  144.      can use /K or /KF but not both together).  Most parameters can have a +
  145.      or - appended to them (ex. /B- or /G+"*").  See below for which
  146.      parameters can use this.  Note that any place GetKey expects a number
  147.      you may enter it in decimal or hexadecimal.  To use hexadecimal add a &
  148.      in front of the number.  For example, &A0 is the same as 160.
  149.  
  150.      Response Editing:
  151.  
  152.      The following edit keys can be used during response entry:
  153.  
  154.      Home -         Moves the cursor to the first character of the response.
  155.  
  156.      End -          Moves the cursor to the right end of the response.
  157.  
  158.      Left Arrow -   Moves the cursor left one space.
  159.  
  160.      Right Arrow -  Moves the cursor right one space.
  161.  
  162.      Ins -          Toggles Insert/Overstrike mode.  A large cursor indicates
  163.                     Insert mode is active.
  164.  
  165.      Del -          Deletes the character under the cursor.
  166.  
  167.      Backspace -    Deletes the character to the left of the cursor.
  168.  
  169.      Esc -          Deletes the entire response.
  170.  
  171.  
  172.      BatKit   ver. 5.7               8/13/96                          Page: 5
  173.  
  174.  
  175.  
  176.      COMMAND LINE SWITCHES for GetKey:
  177.  
  178.      The descriptions below show the default setting for a parameter in
  179.      brackets ([]).  Use a parameter's command line switch to override its
  180.      default setting.  Most of these defaults can be changed by using the /O
  181.      switch to patch GETKEY.EXE.
  182.  
  183.      Many of the parameters are either on or off.  Using the parameter's
  184.      switch will toggle the parameter from its default setting to the
  185.      opposite setting.  You can force these parameters ON or OFF by using +
  186.      or - after the parameter's switch (i.e. /A+ or /G-).
  187.  
  188.      GetKey returns an ERRORLEVEL of 128 if a command line error is
  189.      encountered.
  190.  
  191.      All command line parameters can be specified in the environment by using
  192.      the environment variable GETKEY.  For example, if you enter 'SET
  193.      GETKEY=/m"This is a test: "' at the DOS prompt then every time you run
  194.      GetKey the specified message will be displayed.  If a parameter is also
  195.      specified on the command line then that setting will override the
  196.      setting in the environment.
  197.  
  198.      Where a parameter shows quotes being used you can use a colon (:)
  199.      instead.  In some of these places any character may be used.  In these
  200.      cases the character you use in place of the first quote be will become
  201.      the delimiter.
  202.  
  203.      /A  - Makes the RETURN key be one of the Acceptable responses for GetKey
  204.            (see /K and /KF).  If not used with the /K|/KF parameter it makes
  205.            the RETURN key be the only acceptable response. [Off]
  206.  
  207.      /B  - Toggles the setting for the error Beep produced by an invalid
  208.            response to GetKey (see /K|/KF) and Ctrl-G beeps. [On]
  209.  
  210.      /BL - Toggles screen blanking.  If no argument is given blanking will
  211.            occur after the default time [10].  /BLnn (or /BL=nn) will cause
  212.            blanking to occur after nn minutes. If nn is 0 blanking will occur
  213.            after approximately 30 seconds.  The default screen saver message
  214.            is "Press a key to restore screen".  You can change this by using
  215.            /BL'msg' or /Blnn'msg'.  msg can use @ display code control
  216.            sequences. [On]
  217.  
  218.      /C  - Toggles the Clear screen setting.  The screen is cleared using
  219.            either the original screen colors or the last colors set by
  220.            GetKey.  GetKey determines the original screen colors by looking
  221.            at the attributes at the cursor position that was current when
  222.            GetKey was called.  This means that the color the cursor is when
  223.            you invoke GetKey is the color it thinks the screen is. [Off]
  224.  
  225.      /D  - Toggles the 'Delete (erase) unacceptable response' setting  (see
  226.            /K|/KF). [Off]
  227.  
  228.      /DF - The value "rsp" is entered as a default response.
  229.  
  230.  
  231.      BatKit   ver. 5.7               8/13/96                          Page: 6
  232.  
  233.  
  234.  
  235.      /E  - Toggles the setting for displaying an Error message when the user
  236.            enters an unacceptable response (see /K|/KF). [Off]
  237.  
  238.      /F  - Causes GetKey to display the File "filename".  Using the syntax
  239.            "filename@s" causes GetKey to display only section s of the file.
  240.            See 'Displaying Text' below for more information.
  241.  
  242.      /G  - Toggles the setting for a Guide line.  When ON, it displays a
  243.            guide line showing the maximum acceptable length of the response.
  244.            Use /G"char" to change the character used for the line.  The
  245.            initial default is an underline [_], but this can be changed using
  246.            the /O option. [Off]
  247.  
  248.      /H  - Causes the built-in Help screens to be displayed.  (same as ?)
  249.  
  250.      /I  - Toggles the 'Incompatible display adapter' setting.  When ON it
  251.            forces GetKey to use an 80x25 screen.  (Known to be needed for
  252.            some AT&T adapters.) [Off]
  253.  
  254.      /K  - Makes the list of characters entered ("chars") be the only
  255.            acceptable Keys for GetKey.  GetKey will not continue processing
  256.            until the user presses one of these keys.  Use this option when
  257.            you are looking for one character responses.  For multi-character
  258.            responses use /KF.  When this option is used with responses of
  259.            length greater than 1 only the first character of the response is
  260.            checked.  For example, if one of the characters in "chars" is a 1
  261.            than any response starting with a 1 will be accepted.  To make a
  262.            function key or a character not on the keyboard an acceptable
  263.            character, enter the appropriate value using the ALT-Numeric Key
  264.            Pad method. For example, to make F1 an acceptable key, hold down
  265.            the ALT key, press 1, then 8, and then 7 using the numeric key pad
  266.            and then release the ALT key.  (See /U for case sensitivity)
  267.  
  268.      /KF - Makes the responses in the file "filename" the only acceptable
  269.            responses.  Response files can be broken into sections the same as
  270.            display files using the "filename@s" syntax.  Response files must
  271.  
  272.            be ASCII text files with each response delimited by a carriage
  273.            return or a carriage return and line feed.  This is the format
  274.            produced by EDLIN, EDIT or by doing 'COPY CON filename'.  Most
  275.            word processing packages have an option to produce this type of
  276.            file also.  Be careful when using this or the /K option.  It is
  277.            very easy to get 'trapped'.  For example, your response file does
  278.            not have any single character responses in it and you start GetKey
  279.            without overriding its default maximum response length setting of
  280.            1.  (See /U for case sensitivity)
  281.  
  282.      /L  - Sets the maximum allowable Length of the response.  nnn can be any
  283.            value from 0 to 255.  A value of 0 means that the user cannot
  284.            enter any characters.  This would make GetKey act similar to the
  285.            PAUSE command in a batch file. [1]
  286.  
  287.  
  288.      BatKit   ver. 5.7               8/13/96                          Page: 7
  289.  
  290.  
  291.      /LG - Toggles GetKey response LoGging.  User responses are logged with a
  292.            time and date stamp to a file.  The default log file is
  293.            C:\GETKEY.LOG.  Use "filename" to log to a different file.
  294.  
  295.                Example:  GETKEY /LG"mylog.dat"
  296.  
  297.      /LGC- The normal format for the log file is comma delimited.  For
  298.            example:
  299.  
  300.                "05/08/96","12:55:26","Z","F"
  301.  
  302.            LGC changes this to a space delimited format:
  303.  
  304.                05/08/96  12:55:26  Z  F
  305.  
  306.            The field layout is always Date, Time, ID, Response. [On]
  307.  
  308.      /LGD- Overrides the default date formatting used in response log files.
  309.            Use /LGD"" to prevent the date from being logged. The date
  310.            formatting codes are:
  311.  
  312.                      M - Logs month as a two digit number
  313.                      A - Logs month using a three letter abbreviation
  314.                      L - Logs month using the full name
  315.                      D - Logs day as a two digit number
  316.                      Y - Logs year as a two digit number
  317.                      C - Logs year as a four digit number
  318.  
  319.                   Two digit items are logged with leading zeros if the
  320.                   associated code is entered in upper case.  If a code is
  321.                   entered in lower case then leading zeros are not logged.
  322.                   Letters or characters entered between date format codes
  323.                   are used as separator characters.  A comma is a special
  324.                   case.  If a ',' is used as a separator character then ', '
  325.                   is actually logged.  Here is how the date July 4, 1995
  326.                   would be logged using various date formatting layouts:
  327.  
  328.                      /LGD'MDY'     07-04-95
  329.                      /LGD'mdy'     7-4-95
  330.                      /LGD'm/d/y'   7/4/95
  331.                      /LGD'L,d c'   July, 4 1995
  332.                      /LGD'A,d c'   Jul, 4 1995
  333.                      /LGD'D-A-C'   04-Jul-1995
  334.                      /LGD'd-A'     4-Jul
  335.                      /LGD'L C'     July 1995
  336.  
  337.      /LGI- Sets an ID string to be logged to the response log file.  This can
  338.            be used to identify responses logged from multiple places.
  339.            Environment variables can be used if desired.
  340.  
  341.                Examples: GetKey /LG/LGI"Question 1"
  342.                          GetKey /LG/LGI"%0"
  343.                               (makes the batch file name the ID)
  344.                          GetKey /LG/LGI"%user%"
  345.  
  346.  
  347.      BatKit   ver. 5.7               8/13/96                          Page: 8
  348.  
  349.  
  350.                               (makes the env. Variable USER the ID)
  351.  
  352.      /LGM- When /W is used with response logging GetKey normally does not log
  353.            a message if it times out.  Use /LGM if you want time outs to be
  354.            logged. [Off]
  355.  
  356.      /LGT- Overrides the default time formatting used in response log files.
  357.            Use /LGT"" to prevent the time from being logged. The time
  358.            formatting codes are:
  359.  
  360.                      H - Logs the hour as a 2 digit number using 24 hour time
  361.                      T - Logs the hour as a 2 digit number using 12 hour time
  362.                      A - Logs the hour as a 2 digit number using 12 hour time
  363.                          with AM or PM added at the end
  364.                      M - Logs the minute as a 2 digit number
  365.                      S - Logs the second as a 2 digit number
  366.  
  367.                   When codes are entered as upper case leading zeros are
  368.                   logged.  If they are entered as lower case then leading
  369.                   zeros are not logged.  Letters or characters entered
  370.                   between time format codes are used as separator
  371.                   characters. Here is how the time 15:45:09 would be logged
  372.                   using various time formatting layouts:
  373.  
  374.                      /LGT'HMS'     15:45:09
  375.                      /LGT'hms'     15:45:9
  376.                      /LGT'H.M.S'   15.45.09
  377.                      /LGT'HM'      15:45
  378.                      /LGT'TMS'     03:45:09
  379.                      /LGT'aM'      3:45 PM
  380.  
  381.      /M  - GetKey displays the Message "msg" on the screen before waiting for
  382.            the user's response.
  383.  
  384.      /N  - Toggles GetKey response echoing.  Normally, when the user presses
  385.            a key, that key is displayed (if it is a displayable character).
  386.            Use /N"char" to change the default 'fill-in' character.  For
  387.            example, if you are using GetKey to enter passwords you might like
  388.            to use the command /N"*". [On]
  389.  
  390.      /O  - Change Option's defaults.  GetKey's default settings are shown on
  391.            the first help screen as highlighted fields.  You can change these
  392.            defaults by using the /O option.  Items that can be changed are:
  393.            /B, /BL, /BLnn, /C, /D, /E, /G, /G"char", /I, /L, /N, /N"char",
  394.            /P, /R, /S, /T, /U, /V, /V"var", /X, and /Z.  Be careful about
  395.            changing defaults once you are using GetKey in several places.  If
  396.            an existing batch file toggles a setting, and you change that
  397.            setting's default, your batch file might stop working.  You must
  398.            be in the directory where GETKEY.EXE is located when you use this
  399.            switch.
  400.  
  401.      /P  - Prevents (disables) GetKey snow checking on CGA monitors.  This
  402.            will speed up screen displays, so if your CGA adapter does not
  403.            produce 'snow', or you don't mind it, use this option or set it
  404.  
  405.  
  406.      BatKit   ver. 5.7               8/13/96                          Page: 9
  407.  
  408.  
  409.            using /O.  Actually, this switch toggles the default snow checking
  410.            setting.  If you have a video adapter that GetKey thinks is not a
  411.            CGA then GetKey automatically turns snow checking off.  If this
  412.            produces 'snow' on your screen you may need to use /P. [Off]
  413.  
  414.      /PI - Allow PIping.  Use when you want to 'pipe' a response into GetKey.
  415.            Do not use with /R turned on unless the text to be piped ends with
  416.            a carriage return.
  417.  
  418.            Example: GetKey /PI < RESPOND.TXT
  419.                          GetKey receives input of any text in RESPOND.TXT as
  420.                          if it had been entered from the keyboard.
  421.  
  422.      /R  - Toggles the 'RETURN key Required' setting.  When ON, GetKey will
  423.            not act on a response until RETURN is pressed.  When OFF a
  424.            response is accepted as soon as the maximum number of characters
  425.            have been entered. [Off]
  426.  
  427.      /S  - GetKey can be configured to add a Carriage Return-Line Feed
  428.            sequence after an accepted response.  This option toggles the
  429.            default setting. [Off]
  430.  
  431.      /T  - Toggles the 'Trim leading and trailing spaces' function. [On]
  432.  
  433.      /U  - Toggles the 'force response to UPPERcase' setting.  This switch
  434.            also affects how response checking operates.  When Uppercase is
  435.            ON, response checking is NOT case sensitive.  This means that if
  436.            "Ab" is an acceptable response, a user could enter: "AB", "ab",
  437.            "Ab", or "aB", and GetKey would accept it.  When Uppercase is OFF
  438.            response checking IS case sensitive.  In this case the ONLY
  439.            acceptable response would be: "Ab". [On]
  440.  
  441.      /V  - Toggles the 'insert response into the environment' setting.  Sets
  442.            the Variable name to be used to "var".  If "var" is not used
  443.            GetKey uses the default value [GK]. [Off]
  444.  
  445.      /W  - Tells GetKey to Wait for a given number of seconds before
  446.            continuing.  If no response is entered before the wait period is
  447.            up, an ERRORLEVEL of 0 is returned to the batch file otherwise
  448.            ERRORLEVEL is set as it normally would be.  /W0 is a special
  449.            situation.  When it is used, GetKey does not wait for a key to be
  450.            entered.  Unless there is a character in the buffer, an ERRORLEVEL
  451.            of 0 is returned.
  452.  
  453.      /X  - Toggles GetKey CTRL-BREAK checking.  Text displaying is slower
  454.            with checking ON.  When ON a user can break out of GetKey by using
  455.            CTRL-BREAK. [Off]
  456.  
  457.      /Y  - When GetKey is run from some DOS shell programs (Such as TREE86 or
  458.            HOT) it can not find the environment (see /V) using its normal
  459.            method.  This switch can be used to correct this problem in some
  460.            cases.  For example, if you are using TREE86 try using /Y"TREE86"
  461.            if you are having a problem getting the /V option working.  With
  462.            DOS version 4.0 and later you will probably need to SET the
  463.  
  464.  
  465.      BatKit   ver. 5.7               8/13/96                         Page: 10
  466.  
  467.  
  468.            environment variable you will be using before you start the
  469.            program specified.
  470.  
  471.      /YM - If GetKey is being run from a DOS 'shell' (such as some program's
  472.            'Go to DOS' feature) then normally GetKey will only affect the
  473.            environment (see /V) of the program it is running under.  This
  474.            switch tells GetKey to also make any changes to the main (or root)
  475.            environment.
  476.  
  477.      /YW - THIS OPTION DOES NOT WORK UNDER WINDOWS 95.  If GetKey is being
  478.            run in a DOS session under Windows then normally the /V switch
  479.            only affects the environment for the current DOS session.  This
  480.            switch tells GetKey to also make changes to the main Windows
  481.            environment.  Any DOS sessions started under Windows after this
  482.            will contain the changes.  This provides a somewhat crude method
  483.            of communicating between DOS sessions.  If you plan on using this
  484.            feature you will probably want to pre-load the environment before
  485.            starting Windows.  This is to make sure there is environment
  486.            space available.  For example, the last two lines of your
  487.            AUTOEXEC.BAT might look like this:
  488.  
  489.                     SET GK=This is here to reserve space in the environment
  490.                     WIN
  491.  
  492.            This feature will only work under DOS versions 4.0 and later.
  493.  
  494.      /Z  - Toggles the 'clear (Zap) the type-ahead buffer' function in
  495.            GetKey. [Off]
  496.  
  497.  
  498.      +|- - The above options that toggle a setting can also be used to force
  499.            the setting ON or OFF by adding a + (ON) or - (OFF) to the
  500.            parameter.  For example, /C+ forces screen clearing ON and /C-
  501.            forces it OFF.  This syntax is safer if you plan to modify the
  502.            GetKey default settings using the /O parameter.  The toggle syntax
  503.            provides for a shorter command line entry for users who plan to
  504.            stick with a given GetKey setup and it retains compatibility with
  505.            earlier versions of GetKey.  A + or - can be used with /A, /B, /C,
  506.            /D, /E, /G, /I, /LG, /LGC, /LGM, /N, /P, /R, /S, /T, /U, /V, /X,
  507.            and /Z.
  508.  
  509.  
  510.      BatKit   ver. 5.7               8/13/96                         Page: 11
  511.  
  512.  
  513.  
  514.      DISPLAYING TEXT:
  515.  
  516.         GetKey has two methods of displaying text.  The /M option can be used
  517.      for short messages or prompts.  With this method you can display as much
  518.      text as you have room for on the command line.  The /F method allows you
  519.      to display a file so the amount of text you can display is limited only
  520.      by your disk space.  Both methods can be used together.  If they are the
  521.      file is displayed first.  With both methods you can perform special
  522.      functions through the use of # and @ control character sequences.  Note
  523.      that all letters that are used in a control sequence MUST be UPPER case.
  524.  
  525.         In the case where the control sequence requires a numeric argument
  526.      you can enter the argument in decimal or hexadecimal form.  To use
  527.      hexadecimal preface the number with & (ex. &1A).  You do not need to pad
  528.      the argument to its full length with leading zeros.  Use caution if you
  529.      don't because GetKey will use the wrong value if the control sequence is
  530.      immediately in front of a word starting with 0 through 9 or, if using
  531.      hexadecimal, A through F.  For example, #&1Apple will be seen as the
  532.      color combination #&1A followed by the word "pple" instead of the color
  533.      combination #&01 followed by the word Apple.  Forcing control sequence
  534.      letters to be entered as upper case lessens the possibility of this but
  535.      does not prevent it.
  536.  
  537.         The # control character is used specifically for screen color or
  538.      attribute control.  Hexadecimal is convenient to use for colors because
  539.  
  540.      the first digit will represent the background setting and the second the
  541.      foreground.  For example, #&10 sets the colors to a foreground color of
  542.      0 (black) and the background color to 1 (blue).  The syntax is #&hh
  543.      where &hh is a hexadecimal number.  To see all of the 256 possible
  544.      color/attribute combinations enter GetKey/f"colors" at the DOS prompt.
  545.      GetKey must be able to find the colors file for this to work.  To
  546.      display the # character use ## in your message or file.
  547.  
  548.         The @ control character is used for various functions.  To display
  549.      the @ character use @@.  The @ control sequences are:
  550.  
  551.      @/d...d     - Execute the / command line parameters found between the
  552.                    delimiting characters d.  Any command line parameter may
  553.                    be used however the /C, /I, and /? will not have any
  554.                    effect.  The /F parameter can cause unexpected results in
  555.                    some cases but in most it will appear to be ignored.
  556.                    Using the /M parameter will display the message one time.
  557.                    If you use @JH this means that when re-displaying the
  558.                    screen after a help message the /M message will not
  559.                    appear.
  560.  
  561.                    Example: @/~/k"abc"/z/e~
  562.  
  563.  
  564.      BatKit   ver. 5.7               8/13/96                         Page: 12
  565.  
  566.  
  567.      @Bnnnr[#ccc]d...d
  568.                  - Bounce bars.  Create bounce bar number nnn which will
  569.                    return response r.  The bar will be displayed as the
  570.                    reverse of the existing colors unless a color is specified
  571.                    with #ccc.  The character d is the delimiter marking off
  572.                    the text (indicated above as ...) to be included in the
  573.                    bar.  d must be a character that is not used in the
  574.                    included text.
  575.  
  576.                    Example: @B2S#&10\S. Spreadsheets\
  577.                               This creates the second bounce bar that will
  578.                               return a response of S.  The text included in
  579.                               the bar will be 'S. Spreadsheets'.  The color
  580.                               used to display the bar will be &10.
  581.  
  582.      @BZ         - Bounce bar Zap.  Clears previously entered bounce bars.
  583.                    Bounce bars are also cleared when a new section is
  584.                    displayed.
  585.  
  586.      @C          - Clears the screen.  This is the same as the /C command
  587.                    line parameter except that it may be used anywhere in the
  588.                    file or message.
  589.  
  590.      @CR+        - Turns the CuRsor ON.
  591.  
  592.      @CR-        - Turns the CuRsor OFF.
  593.  
  594.      @DD         - Displays the Date using the current country layout (MM-DD-
  595.                    YY for the USA), updated as needed.  The display layout
  596.                    can be changed.  The date formatting codes are:
  597.  
  598.                      M - Displays month as a two digit number
  599.                      A - Displays month using a three letter abbreviation
  600.                      L - Displays month using the full name
  601.                      D - Displays day as a two digit number
  602.                      Y - Displays year as a two digit number
  603.                      C - Displays year as a four digit number
  604.  
  605.                   Two digit items are displayed with leading zeros if the
  606.                   associated code is entered in upper case.  If a code is
  607.                   entered in lower case then leading zeros are not
  608.                   displayed.  Letters or characters entered between date
  609.                   format codes are used as separator characters.  A comma is
  610.                   a special case.  If a ',' is used as a separator character
  611.                   then ', ' is actually displayed.  Here is how the date
  612.                   July 4, 1995 would display using various date formatting
  613.                   layouts:
  614.  
  615.                      @DD           07-04-95 (for the US)
  616.                      @DD'MDY'      07-04-95
  617.                      @DD'mdy'      7-4-95
  618.                      @DD'm/d/y'    7/4/95
  619.                      @DD'L,d c'    July, 4 1995
  620.                      @DD'A,d c'    Jul, 4 1995
  621.  
  622.  
  623.      BatKit   ver. 5.7               8/13/96                         Page: 13
  624.  
  625.  
  626.                      @DD'D-A-C'    04-Jul-1995
  627.                      @DD'd-A'      4-Jul
  628.                      @DD'L C'      July 1995
  629.  
  630.      @DD+        - Turn Display Date function on.  Only needed if you've used
  631.                    @DD-.
  632.  
  633.      @DD-        - Turn Display Date function off.  This is only useful if
  634.                    you display text on top of an area where the date is being
  635.                    displayed.  The date may show through in this situation
  636.                    unless you use @DD-.
  637.  
  638.      @DT         - Displays the Time using the current country layout
  639.                    (HH:MM:SS for most places), updated continuously.  The
  640.                    display layout can be changed.  The time formatting codes
  641.                    are:
  642.  
  643.                      H - Displays the hour as a 2 digit number using 24 hour
  644.                          time
  645.                      T - Displays the hour as a 2 digit number using 12 hour
  646.                          time
  647.                      A - Displays the hour as a 2 digit number using 12 hour
  648.                          time with AM or PM added at the end
  649.                      M - Displays the minute as a 2 digit number
  650.                      S - Displays the second as a 2 digit number
  651.  
  652.                   When codes are entered as upper case leading zeros are
  653.                   displayed.  If they are entered as lower case then leading
  654.                   zeros are not displayed.  Letters or characters entered
  655.                   between time format codes are used as separator
  656.                   characters. Here is how the time 15:45:09 would display
  657.                   using various time formatting layouts:
  658.  
  659.                      @DT           15:45:09
  660.                      @DT'HMS'      15:45:09
  661.                      @DT'hms'      15:45:9
  662.                      @DT'H.M.S'    15.45.09
  663.                      @DT'HM'       15:45
  664.                      @DT'TMS'      03:45:09
  665.                      @DT'aM'       3:45 PM
  666.  
  667.      @DT+        - Turn Display Time function on.  Only needed if you've used
  668.                    @DT-.
  669.  
  670.      @DT-        - Turn Display Time function off.  This is only useful if
  671.                    you display text on top of an area where the time is being
  672.                    displayed.  The time will show through in this situation
  673.                    unless you use @DT-.
  674.  
  675.      @DV(var)    - Displays the environment Variable named 'var' (for
  676.                    example, PATH).  GetKey will begin displaying the variable
  677.                    at the location where it finds @DV and will stop when the
  678.                    contents of the variable have been completely displayed or
  679.                    at the first non-space character.
  680.  
  681.  
  682.      BatKit   ver. 5.7               8/13/96                         Page: 14
  683.  
  684.  
  685.  
  686.                    Example: /M"Path=@DV(path)          Date=@DT"
  687.                               The first 10 characters of the PATH will be
  688.                               displayed.
  689.  
  690.      @Fnnn       - Flashes the screen nnn times.  If nnn is not given the
  691.                    default value of 1 is used.
  692.  
  693.      @H          - Homes the cursor (to upper left corner) without clearing
  694.                    the screen.  This parameter can be used to "overlay"
  695.                    screens. (See @X and @Y for other cursor positioning
  696.                    commands)
  697.  
  698.      @JH"k1s1[k2s2][k3s3][...]"
  699.                  - Jump to Help.  If key kn is pressed then section sn is
  700.                    displayed.  GetKey will then wait for a key to be pressed.
  701.                    When one is the section that set up the help keys will be
  702.                    re-displayed.  Note that any keys used as help keys can
  703.                    not be included in the response entered by the user.
  704.  
  705.                    Example: @JH"1A2B"
  706.                               If a 1 is pressed the help screen labeled A is
  707.                               displayed.  If a 2 is pressed the help screen
  708.                               labeled B is displayed.
  709.  
  710.      @JIs        - Jump Immediately to section s and begin displaying the
  711.                    text in that section.
  712.  
  713.      @JK"k1s1[k2s2][k3s3][...]"
  714.                  - Jump on Key kn to section sn and begin displaying the text
  715.                    in that section.
  716.  
  717.                    Example: @JK"1A2B"
  718.                               Wait for a key to be pressed.  If the key is a
  719.                               1 jump to section A.  If a 2 is pressed jump to
  720.                               section B.  Ignore anything else.
  721.  
  722.      @JOs"k1s1[k2s2][k3s3][...]"
  723.                  - Jump on key kn to section sn Otherwise if the key pressed
  724.                    is not in the list then jump to section s.
  725.  
  726.                    Example: @JOC"1A2B"
  727.                               Wait for a key to be pressed.  If the key is a
  728.                               1 jump to section A.  If a 2 is pressed jump to
  729.                               section B.  If anything else is pressed jump to
  730.                               section C.
  731.  
  732.      @JPs        - Jump to section s after Pausing for a key to be pressed.
  733.  
  734.      @JWnnns     - Jump to section s after a wait delay of nnn clock ticks.
  735.                    There are 18.2 clock ticks per second.
  736.  
  737.      @Ls         - Labels a section as section s, where s is any character.
  738.                    When used with the /F"filename@s" syntax this allows you
  739.  
  740.  
  741.      BatKit   ver. 5.7               8/13/96                         Page: 15
  742.  
  743.  
  744.                    to display sections of a file instead of the whole file.
  745.                    GetKey will display all of the file from the start of the
  746.                    given section to the end of the file or the start of the
  747.                    next section.  Sections are found very quickly - even
  748.                    those near the end of large files.  If a file with
  749.                    sections is displayed using the syntax /F"filename", then
  750.                    the first section is displayed.  File sectioning can also
  751.                    be used in the same way for response files. (See /KF).
  752.  
  753.      @Mxx        - Switches screen Modes.  xx may be a number or the letter
  754.                    O.  Use the O to return the screen to the mode it was in
  755.                    when GetKey was invoked.  Use the command with caution
  756.                    since some of the modes will not display text.  Values of
  757.                    xx above 7 should only be used when you know what the
  758.                    results will be.  If you try a mode over 7 and your
  759.                    monitor does not support that mode then there is a remote
  760.                    possibility of monitor damage.
  761.  
  762.      @MRxx       - Set the left MaRgin to xx spaces.  Use this command when
  763.                    you want all lines displayed to be indented by xx spaces.
  764.  
  765.      @O          - Returns the screen colors and attributes to the Original
  766.                    start-up values (the cursor color when GetKey was
  767.                    executed).
  768.  
  769.      @P          - Makes GetKey Pause text displaying until the user presses
  770.                    a key.  The key pressed is discarded.  Useful when you
  771.                    want to display more than one screen of text.
  772.  
  773.      @R          - Set cursor position for Response.  Normally, GetKey waits
  774.                    for input wherever the display file (or message) ends.  To
  775.                    force the user response to be entered at some other
  776.                    position on the screen, imbed @R at that point in the
  777.                    display file.
  778.  
  779.      @Snnn       - 'Shifts' the screen's colors.  The number entered is added
  780.                    to the current color at each screen position.  If nnn is
  781.                    not given the default value of 1 is used.
  782.  
  783.      @Tnnn#nnnnn - Generates a Tone.  The nnn parameter is the duration.  The
  784.                    #nnnnn parameter is the frequency.  The higher the number
  785.                    entered for the frequency, the lower the frequency will
  786.                    be.  Both parameters are optional, however use care when
  787.                    following an @T with a color change (#) command.  @T is
  788.                    the equivalent of @T2#&400.  To play a 'rest' use a
  789.                    frequency of 0 (i.e. @T#0).  Tones are played in the
  790.                    background.  This means text displaying and key entry can
  791.                    be occurring while tones are being played.
  792.  
  793.      @TF         - Tone Flush.  Clears all tones from the tone buffer.
  794.  
  795.      @TRnnn[Ttt] - Tone Repeat.  Repeat the last tone or the last tt tones
  796.                    nnn times.  Up to 128 tones can be repeated.
  797.  
  798.  
  799.      BatKit   ver. 5.7               8/13/96                         Page: 16
  800.  
  801.  
  802.                    Example: @TR5T10  - repeat the last 10 tones 5 times
  803.  
  804.      @Vs["var"]  - When a response is entered put the section label s in the
  805.                    environment Variable var.  If var is not given GKSECT is
  806.                    used.
  807.  
  808.      @Wnnnnn     - Causes GetKey to delay (Wait) text displaying for the
  809.                    period nnnnn.  The waiting period used is not machine
  810.                    dependent.  In other words @W10 will delay the display the
  811.                    same length of time no matter what machine it is being run
  812.                    on.  @W18 provides a delay of approximately 1 second.  If
  813.                    nnnnn is not given the default value of 18 is used.  The
  814.                    maximum value for nnnnn is 65535.
  815.  
  816.      @Xddd       - Positions the cursor to column ddd or &hh (where the
  817.  
  818.                    leftmost column is 000).  Note that -ddd or +ddd positions
  819.                    the cursor ddd positions to the left or right of the
  820.                    current position (relative positioning).
  821.  
  822.      @Yddd       - Positions the cursor to row ddd or &hh (where the top row
  823.  
  824.                    is 000).  Note that -ddd or +ddd positions the cursor ddd
  825.                    rows above or below the current position (relative
  826.                    positioning).
  827.  
  828.           Text files to be displayed can be created and edited with any ASCII
  829.      text editor.  Most of ours were done with WordPerfect 5.1 because of its
  830.      convenient line drawing feature.  However, adding the # parameters to
  831.      control color, etc. can be tedious.  Included is a utility to aid in
  832.      screen preparation.  MakeScrn will convert a screen image file into a
  833.      GetKey text file automatically.  The screen image must be in the format
  834.      used by the PC Magazine PAINT program, which can be used for creating
  835.      screens from scratch.  If you have another way of painting screens in
  836.      color (or want to capture existing screens), you can use our GetScrn
  837.      program to capture screens to an image file.
  838.  
  839.  
  840.      BatKit   ver. 5.7               8/13/96                         Page: 17
  841.  
  842.  
  843.  
  844.  
  845.  
  846.      GETKEY 4.x AND GETSTRNG COMPATIBILITY:
  847.  
  848.        GetKey 5.x is highly compatible with pre-5.x versions of GetKey and
  849.      GetStrng.  5.x is a combination of these two programs.  As shipped, the
  850.      defaults for 5.2 and above make the newer versions work similar to older
  851.      versions of GetKey.  The following is a list of incompatibilities and
  852.      differences that you need to watch for:
  853.  
  854.        -  Default number entry is now decimal instead of hexadecimal.  It
  855.  
  856.           seems a lot of people consider decimal the most natural base to
  857.           use.  A strange way of thinking but I bow to the majority in this
  858.           case.  To adapt existing files just take out the & sign where you
  859.           have it and put it in where you don't.  For example, an existing
  860.           #&10 should be changed to #10 and an existing #10 should be changed
  861.           to #&10).  If you don't care for that idea use /4 as one of your
  862.           command line arguments.  This changes the default back to
  863.           hexadecimal.
  864.  
  865.        -  If you do not force responses to upper-case then lower-case letters
  866.           will return their lower-case value.  As shipped, GetKey defaults to
  867.           forced uppercase responses.
  868.  
  869.        -  The /W parameter now lets you enter the waiting period in seconds
  870.  
  871.           rather than a code character that was, in some cases, obscure.
  872.  
  873.        -  The default environment variable (as shipped) is GK.  GetStrng
  874.           users take note.
  875.  
  876.        -  You can now display things in the bottom right corner of the screen
  877.           without having the screen scroll.
  878.  
  879.        -  To allow a SPACE(s) to be entered as a response you will have to
  880.  
  881.           turn trimming (/T) off.  This only concerns responses consisting of
  882.           just spaces.  Embedded spaces are never removed.
  883.  
  884.        -  The following keys are now editing keys and will not return a
  885.           value: Home, End, Left Arrow, Right Arrow, Ins, Del, Esc, and
  886.           Backspace.  If bounce bars are being used then add Up Arrow, Down
  887.           Arrow, and Spacebar to this list.
  888.  
  889.  
  890.      BatKit   ver. 5.7               8/13/96                         Page: 18
  891.  
  892.  
  893.  
  894.  
  895.  
  896.      USING WAIT:
  897.  
  898.        USAGE:  WAIT [?] [/M] [/C] [/U] [/B] [time]
  899.  
  900.           where: ?  - displays help screen
  901.                  /M - turns off the waiting until message
  902.                  /C - turns ON the clock display
  903.                  /U - wait until the time given
  904.                  /B - makes delay non-interruptible
  905.                       (CTRL-BREAK is also disabled)
  906.                  time - 6 digits in HHMMSS format.  Can be entered in
  907.                         any way desired.
  908.                         Examples:  01:02:03   010203
  909.                                    01 hours 02 minutes 03 seconds
  910.  
  911.           Wait provides a way to cause a delay in the processing of a batch
  912.      file.  The delay can be from 1 second to 23 hours 59 minutes and 59
  913.      seconds.  It may be for an amount of time or until a given time.  It can
  914.      be interruptible or non-interruptible.  If it is interruptible, then
  915.      pressing any key will exit Wait.  If no time is entered Wait defaults to
  916.      approximately 1 second.  If an entry error is made, a message is
  917.      displayed, and an ERRORLEVEL of 1 is returned.
  918.  
  919.  
  920.      BatKit   ver. 5.7               8/13/96                         Page: 19
  921.  
  922.  
  923.  
  924.  
  925.  
  926.      USING SAVEDIR:
  927.  
  928.        USAGE: SaveDir [?] [d:][dir] [/H] [/L] [/N]
  929.  
  930.           where d:  = a valid drive
  931.                 dir = a valid directory
  932.                 ?   = display help screens
  933.                 /H  = display help screens
  934.                 /L  = change to the drive and directory saved in LDIR
  935.                 /N  = don't save the current drive and directory in LDIR
  936.  
  937.           SaveDir places the current drive and directory path into the
  938.      environment using the variable names LDRV and LDIR.  Using the syntax
  939.      'SaveDir d:dir' will make SaveDir change to that drive & directory after
  940.      it has saved the info about the current directory.  After SaveDir is
  941.      run, the command CD %LDIR% can be used by a batch file to return to the
  942.      directory current when SaveDir was run, and %LDRV% can be used to change
  943.      to the drive that was current.  The following is an outline of a batch
  944.      file that will save the information about where it is currently, change
  945.      to a new drive and directory, execute some commands, and then return
  946.      where it started:
  947.  
  948.           SaveDir d:dir
  949.           .
  950.           . whatever commands you want
  951.           .
  952.           %LDRV%
  953.           CD %LDIR%
  954.  
  955.      Note that the last two lines could be replaced with 'SaveDir %LDIR%'.
  956.      Another advantage to using SaveDir is that you can change drive AND
  957.      directory with one command instead of the two that DOS requires.
  958.      Issuing consecutive 'SaveDir /L' commands will toggle you between two
  959.      directories.
  960.  
  961.           Error conditions will set ERRORLEVEL as follows:
  962.  
  963.           1 = not enough environment space to insert LDIR
  964.           2 = not enough environment space to insert LDRV
  965.           3 = the DOS being used is earlier than 2.0
  966.           4 = an invalid directory was entered
  967.           5 = an invalid drive was entered
  968.           6 = bad command line parameter entered
  969.           7 = LDIR was not found in the environment
  970.  
  971.  
  972.      BatKit   ver. 5.7               8/13/96                         Page: 20
  973.  
  974.  
  975.  
  976.  
  977.  
  978.      USING GETSCRN:
  979.  
  980.        USAGE:  GETSCRN [U] [I] [x]
  981.  
  982.           where: U- unloads GetScrn from memory
  983.                  I- forces GetScrn to use a screen size of 80X25.  Use this
  984.                     option if GetScrn is not able to determine your screen
  985.                     size.
  986.                  x- any character or number other than U or I.  Sets the
  987.                     hotkey to Alt-x.  The active hotkey is displayed when
  988.                     GetScrn is started.
  989.  
  990.        GetScrn is a text screen capture utility.  When the hotkey is pressed
  991.      GetScrn captures a snapshot of the current screen and saves it to a
  992.      file.  The file name will be SCREENnn.TXT where nn is a number from 00
  993.      to 99.  GetScrn captures the text and display attributes of the screen.
  994.      The screen snapshots produced by GetScrn can be used by utilities such
  995.      as MakeScrn and PC Magazine's PAINT program.
  996.  
  997.  
  998.      BatKit   ver. 5.7               8/13/96                         Page: 21
  999.  
  1000.  
  1001.  
  1002.      USING THE DOS ENVIRONMENT:
  1003.  
  1004.        The environment is a section (or sections) of memory reserved by DOS.
  1005.      Information that may change, such as the path, is stored in it.  The
  1006.      information in the environment is stored in the form varname=text where
  1007.      varname is the name of the environment variable and text is the
  1008.      information associated with it.  In a batch file you can use varname to
  1009.      access the information.  When a batch file encounters the syntax
  1010.      %varname% it replaces it with the information associated with varname.
  1011.      The principle and operation are the same as the %1 through %9 command
  1012.      line arguments that batch files use.  If you want to see what you have
  1013.      in your environment enter SET at the DOS prompt.  To add something to
  1014.      the environment enter SET varname=text.
  1015.  
  1016.        One problem with using the environment is that it defaults to a small
  1017.      size.  Once it is full nothing more can be added unless something else
  1018.      is removed first.  If you are using DOS 3.x or later this is easily
  1019.      overcome by adding a command to the CONFIG.SYS file.  For DOS 3.1 use
  1020.      the command 'SHELL=C:\COMMAND.COM C:\ /E:paragraphs /P'.  For DOS 3.2
  1021.      and later use 'SHELL=C:\COMMAND.COM C:\ /E:bytes /P'.  (Note: These are
  1022.      general examples and may need to be adjusted for your system).  The
  1023.      difference between the two is that DOS 3.1 wants the amount of memory to
  1024.      be reserved to be specified in 16 byte paragraphs and the later versions
  1025.      want it specified in bytes.  If you have COMMAND.COM located somewhere
  1026.      other than the root directory of drive C: then replace C:\COMMAND.COM
  1027.      and C:\ with the drive and path to where you do have it (example:
  1028.      D:\DOS\COMMAND.COM and D:\DOS).  The /P is needed to make AUTOEXEC.BAT
  1029.      execute if it is present.  If you are using a DOS version before 3.x it
  1030.      is more difficult to expand the environment.  You will need to find one
  1031.      of the programs that modifies COMMAND.COM.  You can probably find one on
  1032.      the BBS where you found BatKit or on CompuServe in the IBMNEW or IBMSW
  1033.      forums.
  1034.  
  1035.  
  1036.      GETSCRN and MAKESCRN:
  1037.  
  1038.      If you want to capture screens from other programs for use with GetKey,
  1039.      you can use these utilities.  GetScrn will capture any text screen to a
  1040.  
  1041.      file in the PC Magazine PAINT format.  This file can then be edited with
  1042.      PAINT and converted to a GetKey screen file by MakeScrn.  Although the
  1043.      GetKey screen file can be created or edited by any text editor, it is
  1044.      easier to create or edit screens with boxes, etc. using PAINT, which can
  1045.      be downloaded from PC Magazine's Tips/Utilities Forum (GO ZNT:TIPS) on
  1046.      ZiffNet.  A sample of screens captured with GetScrn and converted with
  1047.      MakeScrn is included in BATDEMO.  GetScrn and MakeScrn are now included
  1048.      with BatKit.  GetScrn is a TSR.  Instructions are displayed when it is
  1049.      run.  Instructions for MakeScrn are displayed when it is run with one
  1050.      exception.  MakeScrn will generate the code for several of the @ display
  1051.      functions.  To do this place a @ in the file to be converted at the spot
  1052.      you wish to have one of the @ functions.  When MakeScrn converts the
  1053.      file it will stop at each @ in the file and prompt you for which
  1054.  
  1055.  
  1056.      BatKit   ver. 5.7               8/13/96                         Page: 22
  1057.  
  1058.  
  1059.      function you want.  Note that MakeScrn does not support all of the @
  1060.      functions.
  1061.  
  1062.  
  1063.      BatKit   ver. 5.7               8/13/96                         Page: 23
  1064.  
  1065.  
  1066.      REGISTERING BatKit:
  1067.  
  1068.         You may copy and distribute this program freely, as long as all parts
  1069.      of the package are included without modification.  BatKit is a shareware
  1070.      product.  If you find it useful after trying it please register it.
  1071.      Registered owners are entitled to receive support and notification of
  1072.      updates.  To register BatKit please send $15 to:
  1073.  
  1074.           Ken Hipple
  1075.           311 Summer Oak Trail
  1076.           Madison, MS  39110
  1077.  
  1078.         Individuals who are CompuServe members may register on-line.  Go to
  1079.      the Shareware Registration area (CIS:SWREG) and follow the instructions.
  1080.      The SWREG ID # for BatKit is 1312.
  1081.  
  1082.      Site License:
  1083.  
  1084.        Site licenses are available for GetKey at the following prices.
  1085.      GetKey site licenses cover use of the other BatKit utilities.
  1086.  
  1087.           10 license pack     $ 95
  1088.           25 license pack      200
  1089.           50 license pack      300
  1090.           Unlimited usage      500
  1091.  
  1092.  
  1093.         BatKit is distributed without warranty, implied or otherwise.  If you
  1094.      have any problems with BatKit or if you have any comments or suggestions
  1095.      please send them to the above address or to me on ZD Net or CompuServe
  1096.      (ID# 72241,65 or 74076,2331).
  1097.  
  1098.         If you distribute BatKit you must include the following files as part
  1099.      of the package:
  1100.  
  1101.        GETKEY.EXE        The GetKey program
  1102.        SAVEDIR.COM       The SaveDir program
  1103.        WAIT.COM          The Wait program
  1104.        GETSCRN.COM       The GetScrn program
  1105.        MAKESCRN.EXE      The MakeScrn program
  1106.        BATKIT.DOC        The BatKit documentation file
  1107.        DEMO.GKF          A text file that demonstrates GetKey's features.
  1108.                          Used by BATDEMO.BAT or type: GETKEY /f"DEMO.GKF".
  1109.        COLOTONE.GKF      A text file that displays all possible tone and
  1110.                          color/attribute combinations.
  1111.        COLOTONE.BAT      A batch file that uses COLOTONE.GKF
  1112.        COLORS            A text file that displays all colors
  1113.                          (Use GetKey /F"Colors")
  1114.        MSDEMO.GKF        A text file used by BATDEMO.BAT to illustrate screen
  1115.                          captures by GetScrn and MakeScrn.
  1116.        MENU.GKF          A text file containing menus for BATDEMO.BAT
  1117.        GETKEY.RSP        A text file that contains valid responses for
  1118.                          BATDEMO.BAT.
  1119.  
  1120.  
  1121.      BatKit   ver. 5.7               8/13/96                         Page: 24
  1122.  
  1123.  
  1124.        BATDEMO.BAT       A batch file illustrating uses of GetKey, Wait, and
  1125.                          SaveDir.
  1126.        DEMO-DOC.BAT      A fully documented version of BATDEMO.BAT.
  1127.        ASMENU.GKF        A sample menu screen text file
  1128.        README.1ST        Getting started and last minute info
  1129.        VENDOR.TXT        Information for shareware vendors
  1130.        REGISTER.TXT      Registration information
  1131.        FILE_ID.DIZ       Description file for BBSs
  1132.        TRAP.GKF          Sample music file
  1133.        TRAPINV.GKF       Sample music file
  1134.        SAINTS.GKF        Sample music file
  1135.  
  1136.      If you receive BatKit and any of these files is missing, please contact
  1137.      the author at the above address or by email.
  1138.  
  1139.  
  1140.      Many thanks go to Conrad Smith for his help in testing, his suggestions,
  1141.      and his help in creating the demo and distribution package.
  1142.  
  1143.  
  1144.                                DISTRIBUTION NOTICE
  1145.  
  1146.      VENDORS:  ASP approved vendors are allowed to distribute BatKit.  Other
  1147.                vendors should contact the author at the above address before
  1148.                beginning to distribute BatKit.
  1149.  
  1150.      BBS operators: BatKit may be uploaded and distributed by any BBS that
  1151.                     does not charge a fee for a download.  Connect time
  1152.                     charges and monthly or yearly flat-rate charges are
  1153.                     acceptable.
  1154.  
  1155.           (The above references to BatKit cover the complete BatKit package
  1156.           and the individual files found in the BatKit package.)
  1157.  
  1158.  
  1159.      BatKit   ver. 5.7               8/13/96                         Page: 25
  1160.  
  1161.  
  1162.                             CHANGES SINCE RELEASE 5.0
  1163.  
  1164.      Version   Change
  1165.        5.1a    Added screen blanking
  1166.                Changed the /W command line parameter so that wait is forced
  1167.                on rather than being toggled
  1168.                Increased accuracy of /W
  1169.  
  1170.        5.1b    Added screen blanking to help and options screens
  1171.  
  1172.        5.1c    Changed file read procedure so that there is no limit to the
  1173.                file size and contents
  1174.  
  1175.        5.1d    Corrected options setting not working after 5.1c change
  1176.                Fixed options setting toggling snow checking on CGA machines
  1177.                Improved snow checking
  1178.                Fixed bad parameter problem when /KF used
  1179.                Fixed problem of numeric arguments being converted wrong if
  1180.                they happened to be split between 2 file reads
  1181.  
  1182.        5.1e    Section labels inside a file were case sensitive.  Corrected.
  1183.                BREAK checking changed so it is either off or on.  Before it
  1184.                was off only during actual display activity
  1185.                Changed highlight color on options screen
  1186.  
  1187.        5.1g    Fixed display problem when snow-checking on
  1188.  
  1189.        5.1h    Fixed problem with echo_char routine
  1190.                Fixed cosmetic problems on options setting screen
  1191.                Fixed 'hanging' problem during screen blanking on monochrome
  1192.                Fixed 'packed file corrupt' error after options setting
  1193.  
  1194.        5.1i    Fixed 'hanging' problem when @W came after an @P
  1195.  
  1196.        5.1j    Fixed /I not working
  1197.  
  1198.        5.1k    Added /Y"program" so /V could be used with programs like
  1199.                TREE86 & /YM so /V would affect the root environment
  1200.                Fixed parsing problem with /BL argument
  1201.                Added @Fnnn control code to 'flash' screen
  1202.  
  1203.        5.1l    Added default values to @F (1), @S (1), and @W (18).
  1204.                @CR followed by @M caused disappearing cursor - fixed
  1205.  
  1206.        5.2     Added the following display options: @B, @BZ, @JC, @JH, @JI,
  1207.                @JK, @JO, @JP, @JW, @TF, @TR, @/, and @V
  1208.                Tones are now played in the background.
  1209.                Fixed 'section not found' problem with large files.
  1210.  
  1211.        5.2a    Added GETKEY environment variable for option setting.
  1212.                Fixed GetKey so it would stop thinking that a totally empty
  1213.                environment was actually full.
  1214.                Fixed problem of @/ not always parsing commands correctly and
  1215.                added @/ to the help screens.
  1216.  
  1217.  
  1218.      BatKit   ver. 5.7               8/13/96                         Page: 26
  1219.  
  1220.  
  1221.                When using /O the screen blank time and response length values
  1222.                on the help screen were being set to the wrong value when a
  1223.                value larger than the max allowed was entered.  Fixed.
  1224.  
  1225.        5.2b    Fixed section labels not being found
  1226.                Fixed problem with @T0
  1227.  
  1228.        5.2c    Snow-checking & bounce-bars together would sometimes cause a
  1229.                crash
  1230.                Added @JH to help screen
  1231.                @/ caused problems with /k -- corrected
  1232.                Changed @M to accept values above 7.
  1233.  
  1234.        5.2d    Forced echo on in options setting screen
  1235.  
  1236.        5.2e    Removed non-existent @JC command from help screen
  1237.  
  1238.        5.3     Added @DD-, @DD+, @DT-, and @DT+ to allow date and time
  1239.                displays to be turned on and off
  1240.                Added @MR to allow a left margin to be set
  1241.  
  1242.        5.4     Added 'allow piping' feature (/PI)
  1243.                Fixed problem when using /g with /l0
  1244.                Fixed 'find master environment' feature
  1245.                Fixed @S parsing problem
  1246.                @V had never been implemented
  1247.  
  1248.        5.5     Added /YW feature
  1249.                Minor changes to the help screen
  1250.  
  1251.        5.6     Added /DF to allow a default response to be entered.
  1252.                Changed time and date displaying so fewer interrupt calls
  1253.                would be made.  GetKey was using too much CPU power when run
  1254.                in the background & would slow down some things like ArcServe
  1255.                backup.  Time & Date displaying was getting done after every
  1256.                keyboard poll.  Changed to use INT 1Ch routine.
  1257.                Turned off cursor while screen saver active
  1258.                Added ability to change how date and time are displayed
  1259.                Changed date display to default to country specific layout
  1260.                Added option to /BL to change screen blanking message
  1261.  
  1262.        5.7     Added response logging features (/LG, /LGC, /LGD, /LGI, /LGM,
  1263.                /LGT)
  1264.                Changed help screen formatting
  1265.                Added /LGC and /LGM to options setting screen